Documentação - Documentação

get https://billing.iugu.com/api/invoices/{competency_month}

Retorna as faturas para o mês de competência informado

Retorna uma lista de faturas do mês de competência informado, incluindo valores totais e pendentes.

Permissão necessária: billing:invoices.show

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables
competency_month Required Type: string Mês de competência no formato YYYY-MM ou 'current' para o mês atual Ex: 2025-04

Query params
customer_workspace_id Required Type: string Identificador do workspace do cliente Ex: 4fHECmQtLdROI4fDLWMiLd

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Response

200

Faturas encontradas

total_amount

Number

Valor total da fatura

Ex: 1000.5

pending_amount

Number

Valor pendente da fatura

Ex: 250.0

competency_month

Integer

Mês de competência (1-12)

Ex: 4

competency_year

Integer

Ano de competência

Ex: 2025

created_at

String

Data de criação da fatura (iso8601)

Ex: 2025-04-15T12:34:56Z

Example

1
2
3
4
5
6
7
8
9
[
  {
    "total_amount": 1000.5,
    "pending_amount": 250.0,
    "competency_month": 4,
    "competency_year": 2025,
    "created_at": "2025-04-15T12:34:56Z"
  }
]

401

Quando houver erro de autenticação

errors

String

Mensagem de erro

Ex: Authentication Error, check your token and try again

Example

1
2
3
{
  "errors": "Authentication Error, check your token and try again"
}

422

ID do workspace inválido ou não fornecido, ou competency_month inválido

errors

String

Mensagem de erro

Ex: Cheque o Workspace ID e tente novamente mais tarde

Example

1
2
3
{
  "errors": "Cheque o Workspace ID e tente novamente mais tarde"
}

404

Assinatura ou faturas não encontradas para o workspace e app informados

errors

String

Mensagem de erro

Ex: Not Found

Example

1
2
3
{
  "errors": "Not Found"
}

500

Em caso de erro de servidor ou externo.
Você deve tentar de novo dentro de alguns minutos.

errors

String

Mensagem de erro

Ex: Internal Server Error, please try again later.

Example

1
2
3
{
  "errors": "Internal Server Error, please try again later."
}

Back

Aplica um desconto na fatura que o cliente tem em aberto (mês corrente)